<!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: CircuitListWidget.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_3776330d706700e272fa8df738fecea6.html">network</a>
</div>
</div>
<div class="contents">
<h1>CircuitListWidget.h</h1><a href="_circuit_list_widget_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 CircuitListWidget.h</span>
<a name="l00013"></a>00013 <span class="comment">** \version $Id: CircuitListWidget.h 3735 2009-04-28 20:28:01Z edmanm $</span>
<a name="l00014"></a>00014 <span class="comment">** \brief Collection of Tor circuits as CircuitItems</span>
<a name="l00015"></a>00015 <span class="comment">*/</span>
<a name="l00016"></a>00016
<a name="l00017"></a>00017 <span class="preprocessor">#ifndef _CIRCUITLISTWIDGET_H</span>
<a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define _CIRCUITLISTWIDGET_H</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span>
<a name="l00020"></a>00020 <span class="preprocessor">#include "<a class="code" href="_circuit_item_8h.html">CircuitItem.h</a>"</span>
<a name="l00021"></a>00021 <span class="preprocessor">#include "<a class="code" href="_stream_item_8h.html">StreamItem.h</a>"</span>
<a name="l00022"></a>00022
<a name="l00023"></a>00023 <span class="preprocessor">#include <QTreeWidget></span>
<a name="l00024"></a>00024 <span class="preprocessor">#include <QList></span>
<a name="l00025"></a>00025 <span class="preprocessor">#include <QMenu></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include <QAction></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include <QMouseEvent></span>
<a name="l00028"></a>00028
<a name="l00029"></a>00029
<a name="l00030"></a><a class="code" href="class_circuit_list_widget.html">00030</a> <span class="keyword">class </span><a class="code" href="class_circuit_list_widget.html">CircuitListWidget</a> : <span class="keyword">public</span> QTreeWidget
<a name="l00031"></a>00031 {
<a name="l00032"></a>00032 Q_OBJECT
<a name="l00033"></a>00033
<a name="l00034"></a>00034 <span class="keyword">public</span>:<span class="comment"></span>
<a name="l00035"></a>00035 <span class="comment"> /** Circuit list columns. */</span>
<a name="l00036"></a><a class="code" href="class_circuit_list_widget.html#a0ee7faae3747824d0a26c43fd1e97e75">00036</a> <span class="keyword">enum</span> <a class="code" href="class_circuit_list_widget.html#a0ee7faae3747824d0a26c43fd1e97e75">Columns</a> {
<a name="l00037"></a><a class="code" href="class_circuit_list_widget.html#a0ee7faae3747824d0a26c43fd1e97e75a95ecebcfbcad6e1b8a039570fcbd8e57">00037</a> <a class="code" href="class_circuit_list_widget.html#a0ee7faae3747824d0a26c43fd1e97e75a95ecebcfbcad6e1b8a039570fcbd8e57">ConnectionColumn</a> = 0, <span class="comment">/**< Column for either the circuit or stream */</span>
<a name="l00038"></a><a class="code" href="class_circuit_list_widget.html#a0ee7faae3747824d0a26c43fd1e97e75a54b82e4482772476310a601f54ceecb8">00038</a> <a class="code" href="class_circuit_list_widget.html#a0ee7faae3747824d0a26c43fd1e97e75a54b82e4482772476310a601f54ceecb8">StatusColumn</a> = 1 <span class="comment">/**< Status of the connection. */</span>
<a name="l00039"></a>00039 };
<a name="l00040"></a>00040 <span class="comment"></span>
<a name="l00041"></a>00041 <span class="comment"> /** Default constructor */</span>
<a name="l00042"></a>00042 <a class="code" href="class_circuit_list_widget.html#a9d5ce03cac30dae5c3e01c2eaaa53d6c">CircuitListWidget</a>(QWidget *parent = 0);
<a name="l00043"></a>00043 <span class="comment"></span>
<a name="l00044"></a>00044 <span class="comment"> /** Adds a circuit to the list. If the circuit already exists in the list,</span>
<a name="l00045"></a>00045 <span class="comment"> * the status and path will be updated. */</span>
<a name="l00046"></a>00046 <span class="keywordtype">void</span> <a class="code" href="class_circuit_list_widget.html#ab8134701211559f0c000c95420946def">addCircuit</a>(<span class="keyword">const</span> <a class="code" href="class_circuit.html">Circuit</a> &circuit);<span class="comment"></span>
<a name="l00047"></a>00047 <span class="comment"> /** Adds a stream to the list. If the stream already exists in the list, the</span>
<a name="l00048"></a>00048 <span class="comment"> * status and path will be updated. */</span>
<a name="l00049"></a>00049 <span class="keywordtype">void</span> <a class="code" href="class_circuit_list_widget.html#afcf86dcaa9f1a653ea7164c8253629dd">addStream</a>(<span class="keyword">const</span> <a class="code" href="class_stream.html">Stream</a> &stream);<span class="comment"></span>
<a name="l00050"></a>00050 <span class="comment"> /** Returns a list of circuits currently in the widget. */</span>
<a name="l00051"></a>00051 QList<Circuit> <a class="code" href="class_circuit_list_widget.html#a14a8bc35a6eb82f2a6117757afe53032">circuits</a>();<span class="comment"></span>
<a name="l00052"></a>00052 <span class="comment"> /** Called when the user changes the UI translation. */</span>
<a name="l00053"></a>00053 <span class="keywordtype">void</span> <a class="code" href="class_circuit_list_widget.html#ad0d21105bb2c7151859b5c5b4a5c78fb">retranslateUi</a>();
<a name="l00054"></a>00054
<a name="l00055"></a>00055 signals:<span class="comment"></span>
<a name="l00056"></a>00056 <span class="comment"> /** Emitted when a circuit item is selected. */</span>
<a name="l00057"></a>00057 <span class="keywordtype">void</span> <a class="code" href="class_circuit_list_widget.html#aa79bad8737c1c65582c6fb8bf8e5a94d">circuitSelected</a>(<a class="code" href="class_circuit.html">Circuit</a> circuit);<span class="comment"></span>
<a name="l00058"></a>00058 <span class="comment"> /** Emitted when a circuit is removed from the list. */</span>
<a name="l00059"></a>00059 <span class="keywordtype">void</span> <a class="code" href="class_circuit_list_widget.html#ad0997fc899c7e63bfbc41dfcb764c1ee">circuitRemoved</a>(<a class="code" href="_circuit_8h.html#a8b7b0182a6d1ff0aab7ab31df9c3f83d">CircuitId</a> circid);<span class="comment"></span>
<a name="l00060"></a>00060 <span class="comment"> /** Emitted when the user selects a circuit to be closed. */</span>
<a name="l00061"></a>00061 <span class="keywordtype">void</span> <a class="code" href="class_circuit_list_widget.html#a399d0ea6232dccad5e5ce473ab382cf2">closeCircuit</a>(<a class="code" href="_circuit_8h.html#a8b7b0182a6d1ff0aab7ab31df9c3f83d">CircuitId</a> circid);<span class="comment"></span>
<a name="l00062"></a>00062 <span class="comment"> /** Emitted when the user selects a stream to be closed. */</span>
<a name="l00063"></a>00063 <span class="keywordtype">void</span> <a class="code" href="class_circuit_list_widget.html#a103dfb4393cf4d54b46519c9f1673287">closeStream</a>(<a class="code" href="_stream_8h.html#a90d94d8a7b979b4c7e07f5869a431064">StreamId</a> streamid);<span class="comment"></span>
<a name="l00064"></a>00064 <span class="comment"> /** Emitted when the user selects a circuit to zoom to. */</span>
<a name="l00065"></a>00065 <span class="keywordtype">void</span> <a class="code" href="class_circuit_list_widget.html#a41b384f6ed16c14e3b3298d9131b78fd">zoomToCircuit</a>(<a class="code" href="_circuit_8h.html#a8b7b0182a6d1ff0aab7ab31df9c3f83d">CircuitId</a> circid);
<a name="l00066"></a>00066
<a name="l00067"></a>00067 <span class="keyword">public</span> slots:<span class="comment"></span>
<a name="l00068"></a>00068 <span class="comment"> /** Clears all circuits and streams from the list. */</span>
<a name="l00069"></a>00069 <span class="keywordtype">void</span> <a class="code" href="class_circuit_list_widget.html#a0ec8b1e956cccae41f807491b9ed0a79">clearCircuits</a>();
<a name="l00070"></a>00070
<a name="l00071"></a>00071 <span class="keyword">private</span> slots:<span class="comment"></span>
<a name="l00072"></a>00072 <span class="comment"> /** Removes the first circuit scheduled to be removed.*/</span>
<a name="l00073"></a>00073 <span class="keywordtype">void</span> <a class="code" href="class_circuit_list_widget.html#adcd147f3c3d817e7c7cf0e620cc03c19">removeCircuit</a>(); <span class="comment"></span>
<a name="l00074"></a>00074 <span class="comment"> /** Removes the first stream scheduled to be removed. */</span>
<a name="l00075"></a>00075 <span class="keywordtype">void</span> <a class="code" href="class_circuit_list_widget.html#a52eb949b9bd3fa14e03afff0084676fb">removeStream</a>();<span class="comment"></span>
<a name="l00076"></a>00076 <span class="comment"> /** Called when the current item selectio has changed. */</span>
<a name="l00077"></a>00077 <span class="keywordtype">void</span> <a class="code" href="class_circuit_list_widget.html#accf71aaf7d4723174d9992b7880d1df2">onSelectionChanged</a>(QTreeWidgetItem *cur, QTreeWidgetItem *prev);<span class="comment"></span>
<a name="l00078"></a>00078 <span class="comment"> /** Called when the user requests a context menu on a circuit or stream in</span>
<a name="l00079"></a>00079 <span class="comment"> * the list and displays a context menu appropriate for whichever type of</span>
<a name="l00080"></a>00080 <span class="comment"> * item is currently selected. */</span>
<a name="l00081"></a>00081 <span class="keywordtype">void</span> <a class="code" href="class_circuit_list_widget.html#ac932ade6b941a2f0eaa527572c1e6207">customContextMenuRequested</a>(<span class="keyword">const</span> QPoint &pos);<span class="comment"></span>
<a name="l00082"></a>00082 <span class="comment"> /** Closes all selected circuits or streams. */</span>
<a name="l00083"></a>00083 <span class="keywordtype">void</span> <a class="code" href="class_circuit_list_widget.html#acbb9112730ea96f23a5cf075aa318a91">closeSelectedConnections</a>();
<a name="l00084"></a>00084
<a name="l00085"></a>00085 <span class="keyword">private</span>:<span class="comment"></span>
<a name="l00086"></a>00086 <span class="comment"> /** Removes the given circuit item and all streams on that circuit. */</span>
<a name="l00087"></a>00087 <span class="keywordtype">void</span> <a class="code" href="class_circuit_list_widget.html#adcd147f3c3d817e7c7cf0e620cc03c19">removeCircuit</a>(<a class="code" href="class_circuit_item.html">CircuitItem</a> *circuit);<span class="comment"></span>
<a name="l00088"></a>00088 <span class="comment"> /** Removes the given stream item. */</span>
<a name="l00089"></a>00089 <span class="keywordtype">void</span> <a class="code" href="class_circuit_list_widget.html#a52eb949b9bd3fa14e03afff0084676fb">removeStream</a>(<a class="code" href="class_stream_item.html">StreamItem</a> *stream);<span class="comment"></span>
<a name="l00090"></a>00090 <span class="comment"> /** Finds the circuit with the given ID. */</span>
<a name="l00091"></a>00091 <a class="code" href="class_circuit_item.html">CircuitItem</a>* <a class="code" href="class_circuit_list_widget.html#a139c575830e5338dd3096042deef157e">findCircuitItem</a>(<span class="keyword">const</span> <a class="code" href="_circuit_8h.html#a8b7b0182a6d1ff0aab7ab31df9c3f83d">CircuitId</a> &circid);<span class="comment"></span>
<a name="l00092"></a>00092 <span class="comment"> /** Finds the stream with the given ID. */</span>
<a name="l00093"></a>00093 <a class="code" href="class_stream_item.html">StreamItem</a>* <a class="code" href="class_circuit_list_widget.html#a3c67287d994a254de8467a06e88884fa">findStreamItem</a>(<span class="keyword">const</span> <a class="code" href="_stream_8h.html#a90d94d8a7b979b4c7e07f5869a431064">StreamId</a> &streamid);<span class="comment"></span>
<a name="l00094"></a>00094 <span class="comment"> /** Schedules the given circuit item to be removed after the given timeout. */</span>
<a name="l00095"></a>00095 <span class="keywordtype">void</span> <a class="code" href="class_circuit_list_widget.html#a2724ddbba7060e08b742f1768f9115d2">scheduleCircuitRemoval</a>(<a class="code" href="class_circuit_item.html">CircuitItem</a> *circuit, <span class="keywordtype">int</span> delay);<span class="comment"></span>
<a name="l00096"></a>00096 <span class="comment"> /** Schedules a stream to be removed after the given timeout. */</span>
<a name="l00097"></a>00097 <span class="keywordtype">void</span> <a class="code" href="class_circuit_list_widget.html#a9b9c3e73d9b07d7f6a5eb319889aad78">scheduleStreamRemoval</a>(<a class="code" href="class_stream_item.html">StreamItem</a> *stream, <span class="keywordtype">int</span> delay);
<a name="l00098"></a>00098 <span class="comment"></span>
<a name="l00099"></a>00099 <span class="comment"> /** List of circuit items to be removed. */</span>
<a name="l00100"></a><a class="code" href="class_circuit_list_widget.html#a03209d5e42f72ac6e1eb18c88bb9135b">00100</a> QList<CircuitItem *> <a class="code" href="class_circuit_list_widget.html#a03209d5e42f72ac6e1eb18c88bb9135b">_circuitRemovalList</a>;<span class="comment"></span>
<a name="l00101"></a>00101 <span class="comment"> /** List of stream items to be removed. */</span>
<a name="l00102"></a><a class="code" href="class_circuit_list_widget.html#aad5db525f48e0eb84d288b9f27d52a98">00102</a> QList<StreamItem *> <a class="code" href="class_circuit_list_widget.html#aad5db525f48e0eb84d288b9f27d52a98">_streamRemovalList</a>;
<a name="l00103"></a>00103 };
<a name="l00104"></a>00104
<a name="l00105"></a>00105 <span class="preprocessor">#endif</span>
<a name="l00106"></a>00106 <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
>
63
