<!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: Vidalia.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>
</div>
</div>
<div class="contents">
<h1>Vidalia.h</h1><a href="_vidalia_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 vidalia.h</span>
<a name="l00013"></a>00013 <span class="comment">** \version $Id: Vidalia.h 3886 2009-06-25 02:56:47Z edmanm $</span>
<a name="l00014"></a>00014 <span class="comment">** \brief Main Vidalia QApplication object</span>
<a name="l00015"></a>00015 <span class="comment">*/</span>
<a name="l00016"></a>00016
<a name="l00017"></a>00017 <span class="preprocessor">#ifndef _VIDALIA_H</span>
<a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define _VIDALIA_H</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span>
<a name="l00020"></a>00020 <span class="preprocessor">#include "<a class="code" href="config_8h.html">config.h</a>"</span>
<a name="l00021"></a>00021 <span class="preprocessor">#include "<a class="code" href="_vidalia_settings_8h.html">VidaliaSettings.h</a>"</span>
<a name="l00022"></a>00022 <span class="preprocessor">#include "<a class="code" href="_log_8h.html">Log.h</a>"</span>
<a name="l00023"></a>00023 <span class="preprocessor">#include "<a class="code" href="_tor_control_8h.html">TorControl.h</a>"</span>
<a name="l00024"></a>00024
<a name="l00025"></a>00025 <span class="preprocessor">#include <QApplication></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include <QMap></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include <QList></span>
<a name="l00028"></a>00028 <span class="preprocessor">#include <QString></span>
<a name="l00029"></a>00029 <span class="preprocessor">#include <QKeySequence></span>
<a name="l00030"></a>00030
<a name="l00031"></a>00031 <span class="preprocessor">#if defined(Q_OS_WIN)</span>
<a name="l00032"></a>00032 <span class="preprocessor"></span><span class="preprocessor">#include <windows.h></span>
<a name="l00033"></a>00033 <span class="preprocessor">#include "<a class="code" href="win32_8h.html">win32.h</a>"</span>
<a name="l00034"></a>00034 <span class="preprocessor">#endif</span>
<a name="l00035"></a>00035 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00036"></a>00036 <span class="comment">/** Pointer to this Vidalia application instance. */</span>
<a name="l00037"></a><a class="code" href="_vidalia_8h.html#aef0a1c1e9430e6b86892ae28b1577294">00037</a> <span class="preprocessor">#define vApp ((Vidalia *)qApp)</span>
<a name="l00038"></a>00038 <span class="preprocessor"></span>
<a name="l00039"></a><a class="code" href="_vidalia_8h.html#ab2d9ba7f4501abfc0e0a2cb52d0f8105">00039</a> <span class="preprocessor">#define vDebug(fmt) (vApp->log(Log::Debug, (fmt)))</span>
<a name="l00040"></a><a class="code" href="_vidalia_8h.html#a7743cb328f470aa8f382716fbcf61daa">00040</a> <span class="preprocessor"></span><span class="preprocessor">#define vInfo(fmt) (vApp->log(Log::Info, (fmt)))</span>
<a name="l00041"></a><a class="code" href="_vidalia_8h.html#a61e4319b31bbbc7eb1a5724b487be75f">00041</a> <span class="preprocessor"></span><span class="preprocessor">#define vNotice(fmt) (vApp->log(Log::Notice, (fmt)))</span>
<a name="l00042"></a><a class="code" href="_vidalia_8h.html#a6d8c1ad992d06eece6f19b8246219779">00042</a> <span class="preprocessor"></span><span class="preprocessor">#define vWarn(fmt) (vApp->log(Log::Warn, (fmt)))</span>
<a name="l00043"></a><a class="code" href="_vidalia_8h.html#a6d72eb09a4436f16d625eeb407801596">00043</a> <span class="preprocessor"></span><span class="preprocessor">#define vError(fmt) (vApp->log(Log::Error, (fmt)))</span>
<a name="l00044"></a>00044 <span class="preprocessor"></span>
<a name="l00045"></a>00045
<a name="l00046"></a><a class="code" href="class_vidalia.html">00046</a> <span class="keyword">class </span><a class="code" href="class_vidalia.html">Vidalia</a> : <span class="keyword">public</span> QApplication
<a name="l00047"></a>00047 {
<a name="l00048"></a>00048 Q_OBJECT
<a name="l00049"></a>00049
<a name="l00050"></a>00050 <span class="keyword">public</span>:<span class="comment"></span>
<a name="l00051"></a>00051 <span class="comment"> /** Constructor. */</span>
<a name="l00052"></a>00052 <a class="code" href="class_vidalia.html#ac17d2f2fde4b2b99113858128fdef5da">Vidalia</a>(QStringList args, <span class="keywordtype">int</span> &argc, <span class="keywordtype">char</span> **argv);<span class="comment"></span>
<a name="l00053"></a>00053 <span class="comment"> /** Destructor. */</span>
<a name="l00054"></a>00054 <a class="code" href="class_vidalia.html#ad52f3059d21b257cfd2c8366e9d77a72">~Vidalia</a>();
<a name="l00055"></a>00055 <span class="comment"></span>
<a name="l00056"></a>00056 <span class="comment"> /** Validates that all arguments were well-formed. */</span>
<a name="l00057"></a>00057 <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="class_vidalia.html#af38b9b24bfc6c705790eafd1aabe4dd3">validateArguments</a>(QString &errmsg);<span class="comment"></span>
<a name="l00058"></a>00058 <span class="comment"> /** Displays usage information for command-line args. */</span>
<a name="l00059"></a>00059 <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_vidalia.html#a91714485213f3c32be4ea7fc672196f5">showUsageMessageBox</a>();<span class="comment"></span>
<a name="l00060"></a>00060 <span class="comment"> /** Returns true if the user wants to see usage information. */</span>
<a name="l00061"></a>00061 <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="class_vidalia.html#ab1a2d5c9fd604562f0435b3fb16ffa20">showUsage</a>();
<a name="l00062"></a>00062 <span class="comment"></span>
<a name="l00063"></a>00063 <span class="comment"> /** Sets the current language. */</span>
<a name="l00064"></a>00064 <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="class_vidalia.html#a2be649772dfbfbad27d5fb25fb220f7e">setLanguage</a>(QString languageCode = QString());<span class="comment"></span>
<a name="l00065"></a>00065 <span class="comment"> /** Sets the current GUI style. */</span>
<a name="l00066"></a>00066 <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="class_vidalia.html#a80c1da46165bb91cdeb1877a75ab1412">setStyle</a>(QString styleKey = QString());
<a name="l00067"></a>00067 <span class="comment"></span>
<a name="l00068"></a>00068 <span class="comment"> /** Returns the current language. */</span>
<a name="l00069"></a><a class="code" href="class_vidalia.html#a5ba4ecce07ab8959e7d3b23fc25ef9f6">00069</a> <span class="keyword">static</span> QString <a class="code" href="class_vidalia.html#a5ba4ecce07ab8959e7d3b23fc25ef9f6">language</a>() { <span class="keywordflow">return</span> <a class="code" href="class_vidalia.html#a29f844316061554a322ae3f1a5e81e47">_language</a>; }<span class="comment"></span>
<a name="l00070"></a>00070 <span class="comment"> /** Returns the current GUI style. */</span>
<a name="l00071"></a><a class="code" href="class_vidalia.html#ae0532b6054045262c5669ff46b2935ea">00071</a> <span class="keyword">static</span> QString <a class="code" href="class_vidalia.html#ae0532b6054045262c5669ff46b2935ea">style</a>() { <span class="keywordflow">return</span> <a class="code" href="class_vidalia.html#a2821088485c52584a19352cb87c49be8">_style</a>; }<span class="comment"></span>
<a name="l00072"></a>00072 <span class="comment"> /** Returns Vidalia's application version. */</span>
<a name="l00073"></a><a class="code" href="class_vidalia.html#ab99f86525d7a293c034de37472a01a1e">00073</a> <span class="keyword">static</span> QString <a class="code" href="class_vidalia.html#ab99f86525d7a293c034de37472a01a1e">version</a>() { <span class="keywordflow">return</span> <a class="code" href="config_8h.html#afa2c3301e77e3b461ba5e9c2701fb0bf">VIDALIA_VERSION</a>; }
<a name="l00074"></a>00074 <span class="comment"></span>
<a name="l00075"></a>00075 <span class="comment"> /** Returns Vidalia's main TorControl object. */</span>
<a name="l00076"></a><a class="code" href="class_vidalia.html#a24c23bc8e35fcf66370d31ef176412d5">00076</a> <span class="keyword">static</span> <a class="code" href="class_tor_control.html">TorControl</a>* <a class="code" href="class_vidalia.html#a24c23bc8e35fcf66370d31ef176412d5">torControl</a>() { <span class="keywordflow">return</span> <a class="code" href="class_vidalia.html#a49b1b47af675df3555da9e1d07bdf45a">_torControl</a>; }
<a name="l00077"></a>00077 <span class="comment"></span>
<a name="l00078"></a>00078 <span class="comment"> /** Returns the location Vidalia uses for its data files. */</span>
<a name="l00079"></a>00079 <span class="keyword">static</span> QString <a class="code" href="class_vidalia.html#a5c923ad28bb9f02299f5c4d3c6c2bde0">dataDirectory</a>();<span class="comment"></span>
<a name="l00080"></a>00080 <span class="comment"> /** Returns the default location of Vidalia's data directory. */</span>
<a name="l00081"></a>00081 <span class="keyword">static</span> QString <a class="code" href="class_vidalia.html#aa95434a737fa648c717b4e81901ab83f">defaultDataDirectory</a>();
<a name="l00082"></a>00082 <span class="comment"></span>
<a name="l00083"></a>00083 <span class="comment"> /** Returns the location of Vidalia's pid file. */</span>
<a name="l00084"></a>00084 <span class="keyword">static</span> QString <a class="code" href="class_vidalia.html#a7ae15b11700701975272ee7ed919608a">pidFile</a>();
<a name="l00085"></a>00085 <span class="comment"></span>
<a name="l00086"></a>00086 <span class="comment"> /** Returns true if Vidalia should read the control password from stdin.</span>
<a name="l00087"></a>00087 <span class="comment"> */</span>
<a name="l00088"></a>00088 <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="class_vidalia.html#a680061c31b8852db6bd4c52f3692419d">readPasswordFromStdin</a>();
<a name="l00089"></a>00089 <span class="comment"></span>
<a name="l00090"></a>00090 <span class="comment"> /** Writes <b>msg</b> with severity <b>level</b> to Vidalia's log. */</span>
<a name="l00091"></a>00091 <span class="keyword">static</span> <a class="code" href="class_log_1_1_log_message.html">Log::LogMessage</a> <a class="code" href="class_vidalia.html#a1713a005dce6df858c313220b28aea27">log</a>(<a class="code" href="class_log.html#a3718f3e276c3d3e23b58a3b8236d196e">Log::LogLevel</a> level, QString msg);
<a name="l00092"></a>00092 <span class="comment"></span>
<a name="l00093"></a>00093 <span class="comment"> /** Enters the main event loop and waits until exit() is called. The signal</span>
<a name="l00094"></a>00094 <span class="comment"> * running() will be emitted when the event loop has started. */</span>
<a name="l00095"></a>00095 <span class="keyword">static</span> <span class="keywordtype">int</span> <a class="code" href="class_vidalia.html#a3f758f16af3bb276827bd88b6d7077f5">run</a>();
<a name="l00096"></a>00096 <span class="comment"></span>
<a name="l00097"></a>00097 <span class="comment"> /** Creates and binds a shortcut such that when <b>key</b> is pressed in</span>
<a name="l00098"></a>00098 <span class="comment"> * <b>sender</b>'s context, <b>receiver</b>'s <b>slot</b> will be called. */</span>
<a name="l00099"></a>00099 <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_vidalia.html#a4f28d73e2f92e6656f7c1c06d41b3569">createShortcut</a>(<span class="keyword">const</span> QKeySequence &key, QWidget *sender,
<a name="l00100"></a>00100 QObject *receiver, <span class="keyword">const</span> <span class="keywordtype">char</span> *slot);
<a name="l00101"></a>00101 <span class="comment"></span>
<a name="l00102"></a>00102 <span class="comment"> /** Creates and binds a shortcut such that when <b>key</b> is pressed in</span>
<a name="l00103"></a>00103 <span class="comment"> * <b>sender</b>'s context, <b>receiver</b>'s <b>slot</b> will be called. */</span>
<a name="l00104"></a>00104 <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_vidalia.html#a4f28d73e2f92e6656f7c1c06d41b3569">createShortcut</a>(<span class="keyword">const</span> QString &key, QWidget *sender,
<a name="l00105"></a>00105 QObject *receiver, <span class="keyword">const</span> <span class="keywordtype">char</span> *slot);
<a name="l00106"></a>00106 <span class="comment"></span>
<a name="l00107"></a>00107 <span class="comment"> /** Loads and installs all available translators for the specified</span>
<a name="l00108"></a>00108 <span class="comment"> * <b>languageCode</b>. All currently installed QTranslator objects will be</span>
<a name="l00109"></a>00109 <span class="comment"> * removed. Returns true if at least Vidalia's language file can be loaded</span>
<a name="l00110"></a>00110 <span class="comment"> * for the given language. Otherwise, returns false and no change is made</span>
<a name="l00111"></a>00111 <span class="comment"> * to the current translators.</span>
<a name="l00112"></a>00112 <span class="comment"> */</span>
<a name="l00113"></a>00113 <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="class_vidalia.html#a2142921b2f78063e911578155fb83122">retranslateUi</a>(<span class="keyword">const</span> QString &languageCode);
<a name="l00114"></a>00114
<a name="l00115"></a>00115 signals:<span class="comment"></span>
<a name="l00116"></a>00116 <span class="comment"> /** Emitted when the application is running and the main event loop has</span>
<a name="l00117"></a>00117 <span class="comment"> * started. */</span>
<a name="l00118"></a>00118 <span class="keywordtype">void</span> <a class="code" href="class_vidalia.html#ab649f911c87f25db4cba603ea0304d97">running</a>();
<a name="l00119"></a>00119
<a name="l00120"></a>00120 <span class="keyword">protected</span>:
<a name="l00121"></a>00121 <span class="preprocessor">#if defined(Q_OS_WIN)</span>
<a name="l00122"></a>00122 <span class="preprocessor"></span><span class="comment"> /** Filters Windows events, looking for events of interest */</span>
<a name="l00123"></a>00123 <span class="keywordtype">bool</span> winEventFilter(MSG *msg, <span class="keywordtype">long</span> *result);
<a name="l00124"></a>00124 <span class="preprocessor">#endif</span>
<a name="l00125"></a>00125 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00126"></a>00126 <span class="comment"> /** Removes all currently installed QTranslators. */</span>
<a name="l00127"></a>00127 <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_vidalia.html#a60526054e1d82c25efb0bc565b310607">removeAllTranslators</a>();
<a name="l00128"></a>00128
<a name="l00129"></a>00129 <span class="keyword">private</span> slots:<span class="comment"></span>
<a name="l00130"></a>00130 <span class="comment"> /** Called when the application's main event loop has started. This method</span>
<a name="l00131"></a>00131 <span class="comment"> * will emit the running() signal to indicate that the application's event</span>
<a name="l00132"></a>00132 <span class="comment"> * loop is running. */</span>
<a name="l00133"></a>00133 <span class="keywordtype">void</span> <a class="code" href="class_vidalia.html#a0bb4a71a35344041ea275f9f45b4eb71">onEventLoopStarted</a>();
<a name="l00134"></a>00134
<a name="l00135"></a>00135 <span class="keyword">private</span>:<span class="comment"></span>
<a name="l00136"></a>00136 <span class="comment"> /** Catches debugging messages from Qt and sends them to </span>
<a name="l00137"></a>00137 <span class="comment"> * Vidalia's logs. */</span>
<a name="l00138"></a>00138 <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_vidalia.html#acd68260ecc040f47690d007e17d0e7f4">qt_msg_handler</a>(QtMsgType type, <span class="keyword">const</span> <span class="keywordtype">char</span> *msg);
<a name="l00139"></a>00139 <span class="comment"></span>
<a name="l00140"></a>00140 <span class="comment"> /** Parse the list of command-line arguments. */</span>
<a name="l00141"></a>00141 <span class="keywordtype">void</span> <a class="code" href="class_vidalia.html#afb33131ec483dac8ce17a048870e7f81">parseArguments</a>(QStringList args);<span class="comment"></span>
<a name="l00142"></a>00142 <span class="comment"> /** Returns true if the specified arguments wants a value. */</span>
<a name="l00143"></a>00143 <span class="keywordtype">bool</span> <a class="code" href="class_vidalia.html#ae7a3fc59035be96c2d5e3e762450e6d5">argNeedsValue</a>(QString argName);
<a name="l00144"></a>00144 <span class="comment"></span>
<a name="l00145"></a>00145 <span class="comment"> /** Copies a default settings file (if one exists) to Vidalia's data</span>
<a name="l00146"></a>00146 <span class="comment"> * directory.</span>
<a name="l00147"></a>00147 <span class="comment"> */</span>
<a name="l00148"></a>00148 <span class="keywordtype">void</span> <a class="code" href="class_vidalia.html#a69ed0c0dcc076e186ab000a6858571ae">copyDefaultSettingsFile</a>() <span class="keyword">const</span>;
<a name="l00149"></a>00149 <span class="comment"></span>
<a name="l00150"></a>00150 <span class="comment"> /** Clears the list of default CA certificates and adds only the ones</span>
<a name="l00151"></a>00151 <span class="comment"> * Vidalia is interested in.</span>
<a name="l00152"></a>00152 <span class="comment"> */</span>
<a name="l00153"></a>00153 <span class="keywordtype">void</span> <a class="code" href="class_vidalia.html#a94de49d3cd9fc8c798ab63eee928df1b">loadDefaultCaCertificates</a>() <span class="keyword">const</span>;
<a name="l00154"></a>00154
<a name="l00155"></a><a class="code" href="class_vidalia.html#ad06d7ad97315c108b2c39db11da6140a">00155</a> <span class="keyword">static</span> QMap<QString, QString> <a class="code" href="class_vidalia.html#ad06d7ad97315c108b2c39db11da6140a">_args</a>; <span class="comment">/**< List of command-line arguments. */</span>
<a name="l00156"></a><a class="code" href="class_vidalia.html#a2821088485c52584a19352cb87c49be8">00156</a> <span class="keyword">static</span> QString <a class="code" href="class_vidalia.html#a2821088485c52584a19352cb87c49be8">_style</a>; <span class="comment">/**< The current GUI style. */</span>
<a name="l00157"></a><a class="code" href="class_vidalia.html#a29f844316061554a322ae3f1a5e81e47">00157</a> <span class="keyword">static</span> QString <a class="code" href="class_vidalia.html#a29f844316061554a322ae3f1a5e81e47">_language</a>; <span class="comment">/**< The current language. */</span>
<a name="l00158"></a><a class="code" href="class_vidalia.html#a49b1b47af675df3555da9e1d07bdf45a">00158</a> <span class="keyword">static</span> <a class="code" href="class_tor_control.html">TorControl</a>* <a class="code" href="class_vidalia.html#a49b1b47af675df3555da9e1d07bdf45a">_torControl</a>; <span class="comment">/**< Vidalia's main TorControl object.*/</span>
<a name="l00159"></a><a class="code" href="class_vidalia.html#a31cf2dd0cad40d7c11a9cde00b1e492d">00159</a> <span class="keyword">static</span> <a class="code" href="class_log.html">Log</a> <a class="code" href="class_vidalia.html#a31cf2dd0cad40d7c11a9cde00b1e492d">_log</a>; <span class="comment">/**< Logs debugging messages to file or stdout. */</span>
<a name="l00160"></a><a class="code" href="class_vidalia.html#a9d6751819b8bdb4e1e3753b853dfbd86">00160</a> <span class="keyword">static</span> QList<QTranslator *> <a class="code" href="class_vidalia.html#a9d6751819b8bdb4e1e3753b853dfbd86">_translators</a>; <span class="comment">/**< List of installed translators. */</span>
<a name="l00161"></a>00161 };
<a name="l00162"></a>00162
<a name="l00163"></a>00163 <span class="preprocessor">#endif</span>
<a name="l00164"></a>00164 <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
>
409
