<!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: ControlCommand.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_67a2ce25601334632bdc5ef4a72c0f17.html">torcontrol</a>
</div>
</div>
<div class="contents">
<h1>ControlCommand.h</h1><a href="_control_command_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 </span>
<a name="l00004"></a>00004 <span class="comment">** you did not receive the LICENSE file with this file, you may obtain it</span>
<a name="l00005"></a>00005 <span class="comment">** from the 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</span>
<a name="l00008"></a>00008 <span class="comment">** the 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 ControlCommand.h</span>
<a name="l00013"></a>00013 <span class="comment">** \version $Id: ControlCommand.h 3735 2009-04-28 20:28:01Z edmanm $</span>
<a name="l00014"></a>00014 <span class="comment">** \brief A command sent to Tor's control interface</span>
<a name="l00015"></a>00015 <span class="comment">*/</span>
<a name="l00016"></a>00016
<a name="l00017"></a>00017 <span class="preprocessor">#ifndef _CONTROLCOMMAND_H</span>
<a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define _CONTROLCOMMAND_H</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span>
<a name="l00020"></a>00020 <span class="preprocessor">#include <QStringList></span>
<a name="l00021"></a>00021
<a name="l00022"></a>00022
<a name="l00023"></a><a class="code" href="class_control_command.html">00023</a> <span class="keyword">class </span><a class="code" href="class_control_command.html">ControlCommand</a>
<a name="l00024"></a>00024 {
<a name="l00025"></a>00025 <span class="keyword">public</span>:
<a name="l00026"></a>00026 <a class="code" href="class_control_command.html#a5437f4a8c7534305f55aa9250a34950e">ControlCommand</a>();
<a name="l00027"></a>00027 <a class="code" href="class_control_command.html#a5437f4a8c7534305f55aa9250a34950e">ControlCommand</a>(<span class="keyword">const</span> QString &<a class="code" href="class_control_command.html#a42e58dd4d17e94d2434eba19318d4fac">keyword</a>);
<a name="l00028"></a>00028 <a class="code" href="class_control_command.html#a5437f4a8c7534305f55aa9250a34950e">ControlCommand</a>(<span class="keyword">const</span> QString &keyword, <span class="keyword">const</span> QString &arg);
<a name="l00029"></a>00029 <a class="code" href="class_control_command.html#a5437f4a8c7534305f55aa9250a34950e">ControlCommand</a>(<span class="keyword">const</span> QString &keyword, <span class="keyword">const</span> QStringList &args);
<a name="l00030"></a>00030 <span class="comment"></span>
<a name="l00031"></a>00031 <span class="comment"> /** Returns the keyword for this control command. */</span>
<a name="l00032"></a><a class="code" href="class_control_command.html#a42e58dd4d17e94d2434eba19318d4fac">00032</a> QString <a class="code" href="class_control_command.html#a42e58dd4d17e94d2434eba19318d4fac">keyword</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="class_control_command.html#ac9e67b8eb679f0d8d81aba2be87e90ba">_keyword</a>; }
<a name="l00033"></a>00033 <span class="comment"></span>
<a name="l00034"></a>00034 <span class="comment"> /** Set the keyword for this control command */</span>
<a name="l00035"></a>00035 <span class="keywordtype">void</span> <a class="code" href="class_control_command.html#af0e7535f3bfa9c85d5b4d853ddfca2b4">setKeyword</a>(<span class="keyword">const</span> QString &keyword);
<a name="l00036"></a>00036 <span class="comment"></span>
<a name="l00037"></a>00037 <span class="comment"> /** Add an argument to this control command */</span>
<a name="l00038"></a>00038 <span class="keywordtype">void</span> <a class="code" href="class_control_command.html#a4f8c58a007da880191178044ae569ec0">addArgument</a>(<span class="keyword">const</span> QString &arg);<span class="comment"></span>
<a name="l00039"></a>00039 <span class="comment"> /** Adds all arguments in <b>args</b> to this control command. */</span>
<a name="l00040"></a>00040 <span class="keywordtype">void</span> <a class="code" href="class_control_command.html#ab5981c4f2760b6f23797ab23b7dc491b">addArguments</a>(<span class="keyword">const</span> QStringList &args);
<a name="l00041"></a>00041 <span class="comment"></span>
<a name="l00042"></a>00042 <span class="comment"> /** Append a data line for this control command */</span>
<a name="l00043"></a>00043 <span class="keywordtype">void</span> <a class="code" href="class_control_command.html#a3d8dab8080ef3956ae70a06a7d11fe8e">appendData</a>(<span class="keyword">const</span> QString &data);
<a name="l00044"></a>00044 <span class="comment"></span>
<a name="l00045"></a>00045 <span class="comment"> /** Format this control command into a format conforming to Tor's v1</span>
<a name="l00046"></a>00046 <span class="comment"> * protocol specification. */</span>
<a name="l00047"></a>00047 QString <a class="code" href="class_control_command.html#a57c94909a90bc9ecb301ff3ef3beeb45">toString</a>() <span class="keyword">const</span>;
<a name="l00048"></a>00048
<a name="l00049"></a>00049 <span class="keyword">private</span>:<span class="comment"></span>
<a name="l00050"></a>00050 <span class="comment"> /** Escape special characters in the supplied string */</span>
<a name="l00051"></a>00051 QString <a class="code" href="class_control_command.html#a38cdbeddf0e8e6b88f4fc474bf2c4a62">escape</a>(<span class="keyword">const</span> QString &str) <span class="keyword">const</span>;
<a name="l00052"></a>00052
<a name="l00053"></a><a class="code" href="class_control_command.html#ac9e67b8eb679f0d8d81aba2be87e90ba">00053</a> QString <a class="code" href="class_control_command.html#ac9e67b8eb679f0d8d81aba2be87e90ba">_keyword</a>;
<a name="l00054"></a><a class="code" href="class_control_command.html#af5c00e7b1b8a5149949befd1b90a0d0a">00054</a> QStringList <a class="code" href="class_control_command.html#af5c00e7b1b8a5149949befd1b90a0d0a">_arguments</a>;
<a name="l00055"></a><a class="code" href="class_control_command.html#a52a26f2b5500737cae3df73f240d763f">00055</a> QStringList <a class="code" href="class_control_command.html#a52a26f2b5500737cae3df73f240d763f">_data</a>;
<a name="l00056"></a>00056 };
<a name="l00057"></a>00057
<a name="l00058"></a>00058 <span class="preprocessor">#endif</span>
<a name="l00059"></a>00059 <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>
distrib
>
Mandriva
>
2010.2
>
i586
>
media
>
contrib-backports
>
by-pkgid
>
9601c7beb4ff23e834bfa171795ed560
>
files
>
77
