CircuitListWidget Class Reference

#include <CircuitListWidget.h>

List of all members.

Public Types

enum  Columns { ConnectionColumn = 0, StatusColumn = 1 }

Public Slots

void clearCircuits ()

Signals

void circuitSelected (Circuit circuit)
void circuitRemoved (CircuitId circid)
void closeCircuit (CircuitId circid)
void closeStream (StreamId streamid)
void zoomToCircuit (CircuitId circid)

Public Member Functions

 CircuitListWidget (QWidget *parent=0)
void addCircuit (const Circuit &circuit)
void addStream (const Stream &stream)
QList< Circuitcircuits ()
void retranslateUi ()

Private Slots

void removeCircuit ()
void removeStream ()
void onSelectionChanged (QTreeWidgetItem *cur, QTreeWidgetItem *prev)
void customContextMenuRequested (const QPoint &pos)
void closeSelectedConnections ()

Private Member Functions

void removeCircuit (CircuitItem *circuit)
void removeStream (StreamItem *stream)
CircuitItemfindCircuitItem (const CircuitId &circid)
StreamItemfindStreamItem (const StreamId &streamid)
void scheduleCircuitRemoval (CircuitItem *circuit, int delay)
void scheduleStreamRemoval (StreamItem *stream, int delay)

Private Attributes

QList< CircuitItem * > _circuitRemovalList
QList< StreamItem * > _streamRemovalList


Detailed Description

Definition at line 30 of file CircuitListWidget.h.


Member Enumeration Documentation

Circuit list columns.

Enumerator:
ConnectionColumn  Column for either the circuit or stream
StatusColumn  Status of the connection.

Definition at line 36 of file CircuitListWidget.h.


Constructor & Destructor Documentation

CircuitListWidget::CircuitListWidget ( QWidget *  parent = 0  ) 

Default constructor

Default constructor.

Definition at line 34 of file CircuitListWidget.cpp.

References closeSelectedConnections(), customContextMenuRequested(), onSelectionChanged(), and vApp.


Member Function Documentation

void CircuitListWidget::addCircuit ( const Circuit circuit  ) 

Adds a circuit to the list. If the circuit already exists in the list, the status and path will be updated.

Adds a circuit to the list. If the circuit already exists in the list, the status and path will be updated.

Definition at line 145 of file CircuitListWidget.cpp.

References Circuit::Closed, CLOSED_CIRCUIT_REMOVE_DELAY, Circuit::Failed, FAILED_CIRCUIT_REMOVE_DELAY, findCircuitItem(), Circuit::id(), scheduleCircuitRemoval(), Circuit::status(), and CircuitItem::update().

void CircuitListWidget::addStream ( const Stream stream  ) 

Adds a stream to the list. If the stream already exists in the list, the status and path will be updated.

Definition at line 171 of file CircuitListWidget.cpp.

References CircuitItem::addStream(), Stream::circuitId(), Stream::Closed, CLOSED_STREAM_REMOVE_DELAY, Stream::Failed, FAILED_STREAM_REMOVE_DELAY, findCircuitItem(), findStreamItem(), Stream::id(), scheduleStreamRemoval(), Stream::status(), and StreamItem::update().

void CircuitListWidget::circuitRemoved ( CircuitId  circid  )  [signal]

Emitted when a circuit is removed from the list.

Referenced by removeCircuit().

CircuitList CircuitListWidget::circuits (  ) 

Returns a list of circuits currently in the widget.

Definition at line 352 of file CircuitListWidget.cpp.

References CircuitItem::circuit(), and i().

void CircuitListWidget::circuitSelected ( Circuit  circuit  )  [signal]

Emitted when a circuit item is selected.

Referenced by onSelectionChanged().

void CircuitListWidget::clearCircuits (  )  [slot]

Clears all circuits and streams from the list.

Definition at line 282 of file CircuitListWidget.cpp.

References _circuitRemovalList, and _streamRemovalList.

void CircuitListWidget::closeCircuit ( CircuitId  circid  )  [signal]

Emitted when the user selects a circuit to be closed.

Referenced by closeSelectedConnections(), and customContextMenuRequested().

void CircuitListWidget::closeSelectedConnections (  )  [private, slot]

Closes all selected circuits or streams.

Definition at line 126 of file CircuitListWidget.cpp.

References closeCircuit(), closeStream(), StreamItem::id(), and CircuitItem::id().

Referenced by CircuitListWidget().

void CircuitListWidget::closeStream ( StreamId  streamid  )  [signal]

Emitted when the user selects a stream to be closed.

Referenced by closeSelectedConnections(), and customContextMenuRequested().

void CircuitListWidget::customContextMenuRequested ( const QPoint &  pos  )  [private, slot]

Called when the user requests a context menu on a circuit or stream in the list and displays a context menu appropriate for whichever type of item is currently selected.

Definition at line 71 of file CircuitListWidget.cpp.

References Circuit::Built, CircuitItem::circuit(), closeCircuit(), closeStream(), StreamItem::id(), CircuitItem::id(), IMG_CLOSE, IMG_ZOOM, Circuit::status(), and zoomToCircuit().

Referenced by CircuitListWidget().

CircuitItem * CircuitListWidget::findCircuitItem ( const CircuitId circid  )  [private]

Finds the circuit with the given ID.

Finds the circuit with the given ID and returns a pointer to that circuit's item in the list.

Definition at line 292 of file CircuitListWidget.cpp.

References i(), and CircuitItem::id().

Referenced by addCircuit(), and addStream().

StreamItem * CircuitListWidget::findStreamItem ( const StreamId streamid  )  [private]

Finds the stream with the given ID.

Finds the stream with the given ID and returns a pointer to that stream's item in the list.

Definition at line 307 of file CircuitListWidget.cpp.

References i(), and StreamItem::id().

Referenced by addStream().

void CircuitListWidget::onSelectionChanged ( QTreeWidgetItem *  cur,
QTreeWidgetItem *  prev 
) [private, slot]

Called when the current item selectio has changed.

Called when the current item selection has changed.

Definition at line 328 of file CircuitListWidget.cpp.

References CircuitItem::circuit(), and circuitSelected().

Referenced by CircuitListWidget().

void CircuitListWidget::removeCircuit ( CircuitItem circuit  )  [private]

Removes the given circuit item and all streams on that circuit.

Definition at line 231 of file CircuitListWidget.cpp.

References _streamRemovalList, CircuitItem::removeStream(), and CircuitItem::streams().

void CircuitListWidget::removeCircuit (  )  [private, slot]

Removes the first circuit scheduled to be removed.

Definition at line 219 of file CircuitListWidget.cpp.

References _circuitRemovalList, CircuitItem::circuit(), circuitRemoved(), and Circuit::id().

Referenced by scheduleCircuitRemoval().

void CircuitListWidget::removeStream ( StreamItem stream  )  [private]

Removes the given stream item.

Definition at line 265 of file CircuitListWidget.cpp.

References CircuitItem::removeStream().

void CircuitListWidget::removeStream (  )  [private, slot]

Removes the first stream scheduled to be removed.

Definition at line 255 of file CircuitListWidget.cpp.

References _streamRemovalList.

Referenced by scheduleStreamRemoval().

void CircuitListWidget::retranslateUi (  ) 

Called when the user changes the UI translation.

Definition at line 54 of file CircuitListWidget.cpp.

References CircuitItem::circuit(), i(), StreamItem::stream(), CircuitItem::streams(), StreamItem::update(), and CircuitItem::update().

void CircuitListWidget::scheduleCircuitRemoval ( CircuitItem circuit,
int  delay 
) [private]

Schedules the given circuit item to be removed after the given timeout.

Schedules the given circuit to be removed after the specified timeout.

Definition at line 199 of file CircuitListWidget.cpp.

References _circuitRemovalList, and removeCircuit().

Referenced by addCircuit().

void CircuitListWidget::scheduleStreamRemoval ( StreamItem stream,
int  delay 
) [private]

Schedules a stream to be removed after the given timeout.

Schedules the given stream to be removed after the specified timeout.

Definition at line 209 of file CircuitListWidget.cpp.

References _streamRemovalList, and removeStream().

Referenced by addStream().

void CircuitListWidget::zoomToCircuit ( CircuitId  circid  )  [signal]

Emitted when the user selects a circuit to zoom to.

Referenced by customContextMenuRequested().


Member Data Documentation

List of circuit items to be removed.

Definition at line 100 of file CircuitListWidget.h.

Referenced by clearCircuits(), removeCircuit(), and scheduleCircuitRemoval().

List of stream items to be removed.

Definition at line 102 of file CircuitListWidget.h.

Referenced by clearCircuits(), removeCircuit(), removeStream(), and scheduleStreamRemoval().


The documentation for this class was generated from the following files:

Generated on Mon Aug 30 19:10:02 2010 for Vidalia by  doxygen 1.5.9