TrafficTree Class Reference

Tree view tailored for displaying network traffic conversations and endpoints. More...

#include <traffic_tree.h>

Inheritance diagram for TrafficTree:

Public Types
enum	eTrafficTreeClipboard { CLIPBOARD_CSV , CLIPBOARD_YAML , CLIPBOARD_JSON }
	Type for the selection of export. More...

Public Slots
void	tapListenerEnabled (bool enable)
	Enables or disables the tap listener.
void	disableTap ()
	Disables the tap completely.
void	columnsChanged (QList< int > columns)
	Slot triggered when columns are changed.

Signals
void	filterAction (QString filter, FilterAction::Action action, FilterAction::ActionType type)
	Signal emitted to perform a display filter action.
void	columnsHaveChanged (QList< int > columns)
	Signal emitted when the visible columns have changed.

Public Member Functions
	TrafficTree (QString baseName, GList **recentColumnList, QWidget *parent=nullptr)
	Constructs a new TrafficTree.
QMenu *	createCopyMenu (QWidget *parent=nullptr)
	Create a menu containing clipboard copy entries for this tab.
void	applyRecentColumns ()
	Applies the recently visible columns configuration.
void	widenColumnToContents (int column)
	Increase column width if necessary to fit contents, but don't narrow it.
virtual void	setModel (QAbstractItemModel *model) override
	Sets the data model for the tree view.

Friends
class	TrafficTreeHeaderView

Detailed Description

Tree view tailored for displaying network traffic conversations and endpoints.

Member Enumeration Documentation

eTrafficTreeClipboard

enum TrafficTree::eTrafficTreeClipboard

Type for the selection of export.

See also

copyToClipboard

Enumerator
CLIPBOARD_CSV	export as CSV
CLIPBOARD_YAML	export as YAML
CLIPBOARD_JSON	export as JSON

Constructor & Destructor Documentation

TrafficTree()

TrafficTree::TrafficTree	(	QString	baseName,
		GList **	recentColumnList,
		QWidget *	parent = nullptr
	)

Constructs a new TrafficTree.

Parameters

baseName	The base name identifying the tree context.
recentColumnList	Pointer to a GList tracking recent columns.
parent	The parent widget, defaults to nullptr.

Member Function Documentation

columnsChanged

void TrafficTree::columnsChanged ( QList< int >  columns )

slot

Slot triggered when columns are changed.

Parameters

columns

List of new visible column indices.

columnsHaveChanged

void TrafficTree::columnsHaveChanged ( QList< int >  columns )

signal

Signal emitted when the visible columns have changed.

Parameters

columns

List of visible column indices.

createCopyMenu()

QMenu * TrafficTree::createCopyMenu

(

QWidget *

parent = nullptr

)

Create a menu containing clipboard copy entries for this tab.

It will create all entries, including copying the content of the currently selected tab to CSV, YAML and JSON

Parameters

parent

the parent object or null

Returns

QMenu* the resulting menu or null

filterAction

void TrafficTree::filterAction ( QString  filter, FilterAction::Action  action, FilterAction::ActionType  type  )

signal

Signal emitted to perform a display filter action.

Parameters

filter	The filter string.
action	The filter action.
type	The filter action type.

setModel()

void TrafficTree::setModel ( QAbstractItemModel *  model )

overridevirtual

Sets the data model for the tree view.

Parameters

model

Pointer to the abstract item model.

tapListenerEnabled

void TrafficTree::tapListenerEnabled ( bool  enable )

slot

Enables or disables the tap listener.

Parameters

enable

True to enable, false to disable.

widenColumnToContents()

void TrafficTree::widenColumnToContents

(

int

column

)

Increase column width if necessary to fit contents, but don't narrow it.

This is used to ensure that the columns are wide enough for newly received data, but to avoid narrowing columns that have been manually widened, especially the Rel Start/Abs Start and Duration columns, since those contain a timeline graph.

Parameters

column

The column index to widen.

Friends And Related Symbol Documentation

TrafficTreeHeaderView

friend class TrafficTreeHeaderView

friend

Grants TrafficTreeHeaderView access to private members.

---

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

• /builds/wireshark/wireshark/ui/qt/widgets/traffic_tree.h
• /builds/wireshark/wireshark/ui/qt/widgets/traffic_tree.cpp