DistributionDialog Class Reference

Dialog counting the value combinations of up to four fields over the packets that match an optional display filter. More...

#include <distribution_dialog.h>

Inheritance diagram for DistributionDialog:

Signals
void	filterAction (QString filter, FilterAction::Action action, FilterAction::ActionType type)
	Emitted when a filter action of the context menu is triggered.
void	showIOGraph (const QString &displayFilter, const QVector< QString > &filters, const QVector< QString > &names)
	Emitted to open an I/O Graph with one graph per selected row.

Public Member Functions
	DistributionDialog (QWidget &parent, CaptureFile &cf, const QString &fields)
	Constructs the Distribution dialog.
	~DistributionDialog ()
	Destroys the dialog.
Public Member Functions inherited from WiresharkDialog
	WiresharkDialog (QWidget &parent, CaptureFile &capture_file)
	Constructs a new WiresharkDialog object.
bool	fileClosed () const
	Checks if the capture file has been closed.
Public Member Functions inherited from GeometryStateDialog
	GeometryStateDialog (QWidget *parent, Qt::WindowFlags f=Qt::Window)
	Constructs a new GeometryStateDialog with the specified parent and window flags.
	~GeometryStateDialog ()
	Save the geometry and splitter state and then destroy the GeometryStateDialog.
void	setWindowModality (Qt::WindowModality windowModality)
	Sets the window modality for the dialog. On non-macOS platforms, this also sets the parent to ensure modal dialogs are always on top of their parent.

Protected Member Functions
void	updateWidgets () override
	Updates the enabled state of the inputs, buttons and actions from the field list, the display filter, the file and the retap state.
void	beginRetapPackets () override
	Disables the inputs while a retap runs.
void	endRetapPackets () override
	Publishes the final counts of a retap, also when no packet matched and therefore no draw happened.
bool	eventFilter (QObject *obj, QEvent *event) override
	Relayouts the chart when the plot is resized.
Protected Member Functions inherited from WiresharkDialog
virtual void	keyPressEvent (QKeyEvent *event) override
	Handles key press events.
virtual void	accept () override
	Accepts the dialog.
virtual void	reject () override
	Rejects the dialog.
void	setWindowSubtitle (const QString &subtitle)
	Set the window subtitle, e.g. "Foo Timeouts". The subtitle and file name will be added to the dialog window title.
const QString &	windowSubtitle ()
	Retrieves the current window subtitle.
bool	registerTapListener (const char *tap_name, void *tap_data, const char *filter, unsigned flags, tap_reset_cb tap_reset, tap_packet_cb tap_packet, tap_draw_cb tap_draw)
	Convenience wrapper for register_tap_listener. Tap listeners registered via this function are automatically removed during destruction. They can also be explicitly removed using remove_tap_listener or removeTapListeners.
virtual void	removeTapListeners ()
	Remove all tap listeners registered via registerTapListener.
bool	listening () const
bool	dialogClosed () const
	Check to see if the user has closed (and not minimized) the dialog.
int	retapDepth () const
	Check to see if we're currently retapping. If this is positive, tapping will fail in process_specified_records.
virtual void	captureFileClosing ()
	Called when the capture file is about to close. This can be used to disconnect taps and similar actions. updateWidgets() is called at the end. To enable/disable widgets captureFileClosed() is more suitable.
virtual void	captureFileClosed ()
	Called when the capture file was closed. This can be used to enable or disable widgets according to the state of file_closed_. updateWidgets() is called at the end.
Protected Member Functions inherited from GeometryStateDialog
bool	loadGeometry (int width=0, int height=0, const QString &dialog_name=QString())
	Loads the geometry and splitter state for the dialog.
void	loadSplitterState (QSplitter *splitter=nullptr)
	Loads the state of a splitter for the dialog.

Additional Inherited Members
Protected Slots inherited from WiresharkDialog
void	captureEvent (CaptureEvent e)
	Handles capture events.
Protected Attributes inherited from WiresharkDialog
CaptureFile &	cap_file_
	Reference to the underlying capture file.
bool	file_closed_
	Flag indicating if the capture file has been closed.

Detailed Description

Dialog counting the value combinations of up to four fields over the packets that match an optional display filter.

The counts are shown in a sortable table with a count, a percentage of the packets and a summary with the normalized Shannon entropy. The tap listener is registered only when fields are applied.

Constructor & Destructor Documentation

DistributionDialog()

DistributionDialog::DistributionDialog	(	QWidget &	parent,
		CaptureFile &	cf,
		const QString &	fields )

Constructs the Distribution dialog.

Parameters

parent	The parent widget.
cf	Capture file whose packets are counted.
fields	Comma-separated field list to fill in, may be empty. Valid fields are applied once the dialog is shown.

Member Function Documentation

beginRetapPackets()

void DistributionDialog::beginRetapPackets ( )

overrideprotectedvirtual

Disables the inputs while a retap runs.

Reimplemented from WiresharkDialog.

endRetapPackets()

void DistributionDialog::endRetapPackets ( )

overrideprotectedvirtual

Publishes the final counts of a retap, also when no packet matched and therefore no draw happened.

Reimplemented from WiresharkDialog.

eventFilter()

bool DistributionDialog::eventFilter ( QObject * obj, QEvent * event )

overrideprotected

Relayouts the chart when the plot is resized.

The bar labels and the x-axis tick count depend on the plot width.

filterAction

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

signal

Emitted when a filter action of the context menu is triggered.

Parameters

filter	The display filter of the row under the cursor.
action	The filter action.
type	The filter action type.

showIOGraph

void DistributionDialog::showIOGraph ( const QString & displayFilter, const QVector< QString > & filters, const QVector< QString > & names )

signal

Emitted to open an I/O Graph with one graph per selected row.

Parameters

displayFilter	The display filter limit that was applied, may be empty.
filters	Display filter of each graph, the row filter combined with the limit when one was applied.
names	Legend name of each graph, the row values.

updateWidgets()

void DistributionDialog::updateWidgets ( )

overrideprotectedvirtual

Updates the enabled state of the inputs, buttons and actions from the field list, the display filter, the file and the retap state.

Reimplemented from WiresharkDialog.

---

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

• /builds/wireshark/wireshark/ui/qt/distribution_dialog.h
• /builds/wireshark/wireshark/ui/qt/distribution_dialog.cpp