Base class for statistics dialogs driven by a tap and an optional display filter, presenting results in a QTreeWidget and supporting filter actions, clipboard copy, and save-as export. More...

#include <tap_parameter_dialog.h>

Inheritance diagram for TapParameterDialog:

Signals
void	filterAction (QString filter, FilterAction::Action action, FilterAction::ActionType type)
	Emitted when the user triggers a filter action from the context menu.

void	updateFilter (QString filter)
	Emitted to push a new display filter to the main window filter bar.

Public Member Functions
	TapParameterDialog (QWidget &parent, CaptureFile &cf, int help_topic=0)
	Constructs the tap parameter dialog and registers it for retapping.

	~TapParameterDialog ()
	Destroys the dialog, deregisters the tap, and releases UI resources.

QTreeWidget *	statsTreeWidget ()
	Returns the statistics results tree widget for use by subclasses.

QLineEdit *	displayFilterLineEdit ()
	Returns the display filter line edit widget for use by subclasses.

QPushButton *	applyFilterButton ()
	Returns the Apply Filter button for use by subclasses.

QVBoxLayout *	verticalLayout ()
	Returns the main vertical layout for use by subclasses that need to insert additional widgets.

QHBoxLayout *	filterLayout ()
	Returns the filter bar horizontal layout for use by subclasses.

void	drawTreeItems ()
	Triggers a full redraw of all tree items, typically called after the tap has finished accumulating data.

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.

Static Public Member Functions
static const QString &	actionName ()
	Returns the action name string used to identify this dialog type in menus.

static void	registerDialog (const QString title, const char *cfg_abbr, register_stat_group_t group, stat_tap_init_cb tap_init_cb, tpdCreator creator)
	Registers a TapParameterDialog subclass so it can be opened via the statistics menu or the "-z" command-line option.

static TapParameterDialog *	showTapParameterStatistics (QWidget &parent, CaptureFile &cf, const QString cfg_str, const QString arg, void *)
	Finds or creates and shows the tap statistics dialog matching `cfg_str`.

Protected Slots
void	filterActionTriggered ()
	Applies the filter action associated with the triggered context menu action.

void	collapseAllActionTriggered ()
	Collapses all items in the statistics tree.

void	expandAllActionTriggered ()
	Expands all items in the statistics tree.

void	updateWidgets ()
	Refreshes the enabled/disabled state of UI widgets based on current capture and filter state.

Protected Slots inherited from WiresharkDialog
void	captureEvent (CaptureEvent e)
	Handles capture events.

Protected Member Functions
void	contextMenuEvent (QContextMenuEvent *event)
	Shows the context menu with filter and tree collapse/expand actions.

void	addFilterActions ()
	Populates the context menu with filter actions for the selected tree item.

void	addTreeCollapseAllActions ()
	Adds "Collapse All" and "Expand All" actions to the context menu.

QString	displayFilter ()
	Returns the current display filter string from the filter line edit.

void	setDisplayFilter (const QString &filter)
	Sets the display filter line edit to the given expression.

void	setHint (const QString &hint)
	Sets the hint text shown below the tree widget.

void	setRetapOnShow (bool retap)
	Controls whether packets are retapped when the dialog is first shown. RPC statistics dialogs should disable this to manage their own retap timing.

Protected Member Functions inherited from WiresharkDialog
virtual void	keyPressEvent (QKeyEvent *event)
	Handles key press events.

virtual void	accept ()
	Accepts the dialog.

virtual void	reject ()
	Rejects the dialog.

virtual void	beginRetapPackets ()
	Mark the start of a code block that retaps packets. If the user closes the dialog while tapping, the dialog will not be destroyed until endRetapPackets is called.

virtual void	endRetapPackets ()
	Mark the end of a code block that retaps packets. If the user has closed the dialog it will be destroyed at this point.

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.

virtual void	updateWidgets ()
	Updates the state and contents of the dialog's widgets.

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	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
void	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 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

Base class for statistics dialogs driven by a tap and an optional display filter, presenting results in a QTreeWidget and supporting filter actions, clipboard copy, and save-as export.

Constructor & Destructor Documentation

◆ TapParameterDialog()

TapParameterDialog::TapParameterDialog	(	QWidget &	parent,
		CaptureFile &	cf,
		int	help_topic = `0`
	)

explicit

Constructs the tap parameter dialog and registers it for retapping.

Parameters

parent	Parent widget; must be a valid window.
cf	The current capture file to tap.
help_topic	Wireshark help topic ID opened by the Help button; 0 for none.

Member Function Documentation

◆ actionName()

static const QString & TapParameterDialog::actionName ( )

inlinestatic

Returns the action name string used to identify this dialog type in menus.

Returns: Reference to the static action name string.

◆ applyFilterButton()

QPushButton * TapParameterDialog::applyFilterButton ( )

Returns the Apply Filter button for use by subclasses.

Returns: Pointer to the internal QPushButton.

◆ contextMenuEvent()

void TapParameterDialog::contextMenuEvent ( QContextMenuEvent * event )

protected

Shows the context menu with filter and tree collapse/expand actions.

Parameters

event The context menu event carrying the cursor position.

◆ displayFilter()

QString TapParameterDialog::displayFilter ( )

protected

Returns the current display filter string from the filter line edit.

Returns: Current display filter expression, or an empty string if none is set.

◆ displayFilterLineEdit()

QLineEdit * TapParameterDialog::displayFilterLineEdit ( )

Returns the display filter line edit widget for use by subclasses.

Returns: Pointer to the internal QLineEdit.

◆ filterAction

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

signal

Emitted when the user triggers a filter action from the context menu.

Parameters

filter	The filter expression to apply.
action	The action to perform (apply, prepare, etc.).
type	The action type (selected, not selected, etc.).

◆ filterLayout()

QHBoxLayout * TapParameterDialog::filterLayout ( )

Returns the filter bar horizontal layout for use by subclasses.

Returns: Pointer to the internal QHBoxLayout.

◆ registerDialog()

void TapParameterDialog::registerDialog	(	const QString	title,
		const char *	cfg_abbr,
		register_stat_group_t	group,
		stat_tap_init_cb	tap_init_cb,
		tpdCreator	creator
	)

static

Registers a TapParameterDialog subclass so it can be opened via the statistics menu or the "-z" command-line option.

Parameters

title	Menu display title for the statistics dialog.
cfg_abbr	Short configuration abbreviation used in "-z" arguments.
group	Statistics menu group the dialog belongs to.
tap_init_cb	Tap initialisation callback invoked when the tap is registered.
creator	Factory function used to instantiate the dialog.

◆ setDisplayFilter()

void TapParameterDialog::setDisplayFilter ( const QString & filter )

protected

Sets the display filter line edit to the given expression.

Parameters

filter Filter expression to display.

◆ setHint()

void TapParameterDialog::setHint ( const QString & hint )

protected

Sets the hint text shown below the tree widget.

Parameters

hint	Hint string to display; may be empty to clear the hint.

◆ setRetapOnShow()

void TapParameterDialog::setRetapOnShow ( bool retap )

protected

Controls whether packets are retapped when the dialog is first shown. RPC statistics dialogs should disable this to manage their own retap timing.

Parameters

retap true to retap on first show (default); false to suppress.

◆ showTapParameterStatistics()

TapParameterDialog * TapParameterDialog::showTapParameterStatistics	(	QWidget &	parent,
		CaptureFile &	cf,
		const QString	cfg_str,
		const QString	arg,
		void *
	)

static

Finds or creates and shows the tap statistics dialog matching cfg_str.

Parameters

parent	Parent widget for the dialog.
cf	The current capture file.
cfg_str	Configuration string identifying the registered tap dialog.
arg	Optional "-z" argument string.

Returns: Pointer to the shown TapParameterDialog, or nullptr on failure.

◆ statsTreeWidget()

QTreeWidget * TapParameterDialog::statsTreeWidget ( )

Returns the statistics results tree widget for use by subclasses.

Returns: Pointer to the internal QTreeWidget.

◆ updateFilter

void TapParameterDialog::updateFilter ( QString filter )

signal

Emitted to push a new display filter to the main window filter bar.

Parameters

filter The filter expression to apply.

◆ verticalLayout()

QVBoxLayout * TapParameterDialog::verticalLayout ( )

Returns the main vertical layout for use by subclasses that need to insert additional widgets.

Returns: Pointer to the internal QVBoxLayout.

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

/builds/wireshark/wireshark/ui/qt/tap_parameter_dialog.h
/builds/wireshark/wireshark/ui/qt/tap_parameter_dialog.cpp

Signals

Public Member Functions

Static Public Member Functions

Protected Slots

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TapParameterDialog()

Member Function Documentation

◆ actionName()

◆ applyFilterButton()

◆ contextMenuEvent()

◆ displayFilter()

◆ displayFilterLineEdit()

◆ filterAction

◆ filterLayout()

◆ registerDialog()

◆ setDisplayFilter()

◆ setHint()

◆ setRetapOnShow()

◆ showTapParameterStatistics()

◆ statsTreeWidget()

◆ updateFilter

◆ verticalLayout()